home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / bbs / qfbd109.zip / QFB.DOC < prev    next >
Text File  |  1996-06-21  |  14KB  |  325 lines
  1.         **************************************************************
  2.         *                                                            *
  3.         *                                                            *
  4.         *                   *****   *******  ******                  *
  5.         *                  **   **   **   *   **  **                 *
  6.         *                  **   **   ** *     **  **                 *
  7.         *                  **   **   ****     *****                  *
  8.         *                  **   **   ** *     **  **                 *
  9.         *                  **   **   **       **  **                 *
  10.         *                   ***** * ****     ******                  *
  11.         *                                                            *
  12.         *                                                            *
  13.         *                  A Quick File Base Builder                 *
  14.         *                 v 1.09 for Maximus 3.xx (*)                *
  15.         *                                                            *
  16.         **************************************************************
  17.         *                                                            *
  18.         *         (C) Copyright 1995-1996 by Alberto Pasquale        *
  19.         *                                                            *
  20.         *            A L L   R I G H T S   R E S E R V E D           *
  21.         *                                                            *
  22.         *                    F R E E W A R E                         *
  23.         *                                                            *
  24.         **************************************************************
  25.         
  26.         
  27.         * Maximus is a trademark of Lanius Corporation
  28.         
  29.  
  30.                   (c) Copyright 1995-1996 by Alberto Pasquale
  31.         
  32.                                 F R E E W A R E
  33.         
  34.                                     LICENSE
  35.         
  36.         
  37.         You may copy, distribute and use this program freely, provided
  38.         you do not modify the original archive and Copyrights.
  39.         
  40.         
  41.                                    DISCLAIMER
  42.         
  43.         You are entitled to use this freeware program "as is". No
  44.         guarantee can be given on the performance of the program. The
  45.         author will not be liable for any damage or loss related to the
  46.         use of this program.
  47.         
  48.         
  49.                                     Overview
  50.         
  51.         
  52.         QFB is a substitute for the FB (Dos) or FBP (OS/2) program by
  53.         Scott J. Dudley for building a Maximus 3.xx file-base (Maximus
  54.         is a trademark of Lanius Corporation).
  55.         
  56.         Main characteristics:
  57.         
  58.         - Generates UniFiles.Idx in addition to the standard
  59.           MaxFiles.Idx; UniFiles.Idx is an index file like MaxFiles.Idx
  60.           but with no duplicates (in the case of dupes, the file in the
  61.           first defined area is kept in the index).
  62.         
  63.           You can use UniFiles.Idx as a file-request index for your
  64.           mailer (e.g. BinkleyTerm (c) Bit Bucket Software)
  65.         
  66.         - Support for multi-line descriptions.
  67.         
  68.           Usually the description of a file in the FILES.BBS is
  69.           contained in a single physical line: Maximus will word wrap
  70.           and align when displaying it to the user.
  71.         
  72.           The problems come when you import the multi-line file_id.diz
  73.           descriptions into the FILES.BBS in order to make Maximus show
  74.           them to the user keeping the original formatting.
  75.         
  76.           As a matter of facts, Maximus (partially) supports
  77.           "continuation" lines that begin with '|' or '+' (second or
  78.           greater column). However many people like using NO
  79.           continuation character: they add multi-line descriptions one
  80.           line after another, indenting the subsequent lines so that
  81.           Maximus shows them aligned (but it does not recognize them in
  82.           the case of hurl, kill etc.). File management programs are
  83.           then used to correctly manage the areas.
  84.         
  85.           QFB supports a user-defined continuation character and
  86.           position, which default to the space ' ' and 31 (columns)
  87.           respectively (see the -c command line switch).
  88.         
  89.           QFB adds continuation lines to the FILES.DMP without loosing
  90.           formatting. You can verify this by using the L)ocate or
  91.           N)ewfiles command of Maximus. FB/FBP, on the contrary,
  92.           concatenate all the lines together (when they area recognized
  93.           as continuation lines...).
  94.         
  95.           There is a side effect, though: The L)ocate and N)ewfiles
  96.           commands show the continuation lines aligned at left.
  97.           Since this behaviour is not appreciated by some SysOps, the
  98.           "-d" command line switch allows to output a unique-line
  99.           description to FILES.DMP: original formatting is lost (as with
  100.           FB/FBP) but the entire description is word-wrapped and aligned
  101.           by Maximus.
  102.         
  103.         - Very fast update operation (when a list of areas is specified
  104.           on the command line or the -n switch is used).
  105.         
  106.         - Fast operation even in the full-build.
  107.         
  108.         - The -n switch allows to update the filebase by compiling only
  109.           modified areas, even if you do not have a list of area names
  110.           available.
  111.         
  112.         - Area names can be specified using the '?' and '*' wildcards as
  113.           per the OS/2 rules. E.G. "*OS2*" includes all areas whose name
  114.           contains "OS2".
  115.         
  116.         - Can be used with CD-ROMs with no need to copy the FILES.BBS to
  117.           a hard-disk directory, provided you don't really need the
  118.           DAT/DMP/IDX files for the area: the global indexes
  119.           (MaxFiles.Idx and UniFiles.Idx) will contain the data for
  120.           these areas so that File-Request, Global Download and Upload
  121.           Dupe Check will work anyway.
  122.         
  123.         - Does not abort nor prompt user in the case of "drive not
  124.           ready" or "write protected" errors.
  125.         
  126.         - Retries for many seconds in case of a sharing violation.
  127.           Please note that in the case of protracted inability to open a
  128.           DAT/DMP/IDX file for write, QFB could report a "Write
  129.           Protected" area instead of the sharing violation. It will
  130.           proceed anyway as if the unit were write protected.
  131.         
  132.         - All ApWorks programs that access the FileBase use a
  133.           "FileBase.Bsy" flag in the Maximus system directory to avoid
  134.           concurrent writes to the same filebase. There is no problem in
  135.           the case the FileBase.Bsy flag is not deleted due to abnormal
  136.           terminations or power failures, so you do not need to delete
  137.           it in the startup.cmd/autoexec.bat as with other programs.
  138.         
  139.         
  140.         
  141.                                          Usage
  142.         
  143.         
  144.         The command line parameters are the same as with FB/FBP, with a
  145.         few exceptions:
  146.         
  147.         QFB [<switches>] [<area> ...]
  148.         
  149.         If no command line parameter is given, the help is shown. If no
  150.         <area> is given and the -n switch is not used, all areas are
  151.         compiled.
  152.         
  153.         
  154.          -a
  155.                 Compile all areas.
  156.         
  157.                 This is the default, but the switch is needed when no
  158.                 other switches are used (QFB shows help on an empty
  159.                 command).
  160.         
  161.         
  162.          -c[<nn>[<c>|#<nnn>]]
  163.         
  164.                 The default for continuation column/character is 31/' '.
  165.                 That is, if a line that starts with 31 spaces is found
  166.                 after a description line in the FILES.BBS, then it is
  167.                 taken as a continuation line. Empty lines are also taken
  168.                 as continuation lines, in order to allow correct
  169.                 processing of file_id.diz descripti